Clean up alert channel constructs and add back missing ones#233
Clean up alert channel constructs and add back missing ones#233
Conversation
… fromId() section
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
| <AlertChannelOptionsTable /> | ||
|
|
||
| Alert channels are assigned to checks, monitors, and groups by instantiating a class and adding the resulting object to the | ||
| `alertChannels` array. |
There was a problem hiding this comment.
@guolau IMO a simple code example feels like it would be helpful here, for folks who might have landed here early on in the journey.
| ## Using `fromId()` to reference an existing channel | ||
|
|
||
| You can reference an existing alert channel in your Checkly account using the `fromId()` method on any `AlertChannel` | ||
| class. When your CLI project is responsible for creating and managing alert channels, it integrates seamlessly with Checkly's deployment control mechanisms. This ensures that any changes made are thoroughly validated. |
There was a problem hiding this comment.
@guolau somehow I don't think this is hitting the nail on the head. Are we cautioning people against using fromId? What are the risks? When should it still be used?
There was a problem hiding this comment.
I think we need to be more openly prescriptive here and direct folks to managing everything via CLI, spelling out exceptions clearly. The points are already on this page but maybe we can make this explanation shorter and sharper.
|
|
||
| ## Configuration | ||
|
|
||
| <Tabs> |
There was a problem hiding this comment.
@guolau since we are at it, I don't think this tabbed section provides any value. It is entirely redundant to what comes afterwards, which is more readable and comprehensive anyway. Let's remove this from this and all other alert channel construct pages.
| }) | ||
| ``` | ||
|
|
||
| ```ts Advanced Example |
There was a problem hiding this comment.
@guolau nit: would be nice if this could be collapsed as it takes up a large portion of the page.
| ], | ||
| }) | ||
| ``` | ||
| The request body template, usually JSON. You can use [Handlebars-style template variables]((/integrations/alerts/webhooks#template-variables)) to add custom data to the template. |
There was a problem hiding this comment.
@guolau this link is malformed and 404s currently
2 participants
Affected Components
Summary of changes
This was a general cleanup of the alert channel construct pages, including adding back some pages that were missing. Old docs for reference
fromId().nameproperties). I removed the examples for simpler properties